build: fall back to previous image version on release PRs by meltsufin · Pull Request #12848 · googleapis/google-cloud-java

meltsufin · 2026-04-18T02:03:40Z

The library generation pipeline fails on release PRs because it attempts to pull a Docker image version that has not yet been built or pushed to the registry.

This PR adds a fallback mechanism in hermetic_library_generation.sh to use the previous version of the image from the main branch if the requested version fails to pull on a release PR.

To verify this in CI, this branch is named with the prefix 'release-please--' to simulate a release PR.

Fixes #12825

gemini-code-assist

Code Review

This pull request introduces a fallback mechanism for the hermetic library generation script. When a release PR branch is detected, the script attempts to pull the specified Docker image; if it fails, it tries to extract and use the image tag from the target branch's workflow configuration. The review feedback suggests improving the robustness of the tag extraction logic to better handle potential multiple matches, comments, or colons within the YAML file.

The library generation pipeline fails on release PRs because it attempts to pull a Docker image version that has not yet been built or pushed to the registry. This PR adds a fallback mechanism in hermetic_library_generation.sh to use the previous version of the image from the main branch if the requested version fails to pull on a release PR. To verify this in CI, this branch is named with the prefix 'release-please--' to simulate a release PR. Fixes #12825

meltsufin · 2026-04-18T02:49:37Z

Fallback validated in a separate release simulation PR #12849:

+ [[ release-please--simulation =~ ^release-please-- ]]
+ echo 'Detected release PR branch: release-please--simulation'
+ docker pull gcr.io/cloud-devrel-public-resources/java-library-generation:9.99.9
Detected release PR branch: release-please--simulation
Error response from daemon: manifest for gcr.io/cloud-devrel-public-resources/java-library-generation:9.99.9 not found: manifest unknown: Failed to fetch "9.99.9"
+ echo 'Image not found for version 9.99.9. Falling back to previous version from main.'
Image not found for version 9.99.9. Falling back to previous version from main.
++ git show main:.github/workflows/hermetic_library_generation.yaml
++ grep -m 1 '^[[:space:]]*image_tag:'
++ cut -d : -f 2-
++ cut -d '#' -f 1
++ xargs
+ previous_tag=2.71.0
+ '[' -n 2.71.0 ']'
+ echo 'Using previous image version: 2.71.0'
+ image_tag=2.71.0
Using previous image version: 2.71.0
++ id -u
++ id -g
++ pwd
+ docker run --rm -u 1001:1001 -v /home/runner/work/google-cloud-java/google-cloud-java:/workspace -v /tmp/tmp.dG9h7KnPTo:/workspace/googleapis -e GENERATOR_VERSION=2.71.0 gcr.io/cloud-devrel-public-resources/java-library-generation:2.71.0 --generation-config-path=/workspace/generation_config.yaml --library-names= --api-definitions-path=/workspace/googleapis
Unable to find image 'gcr.io/cloud-devrel-public-resources/java-library-generation:2.71.0' locally
2.71.0: Pulling from cloud-devrel-public-resources/java-library-generation

blakeli0 · 2026-04-20T17:12:14Z


 # run hermetic code generation docker image.
+# Attempt to pull the image to see if it exists on release PRs.
+if [[ "$current_branch" =~ ^release-please-- ]]; then


We could create release-please PRs from CLI as well.

That's fine, as long as the branch prefix is release-please--.

But that means we have to remember using release-please-- as the branch name, is there any harm we do this for every branches?

You shouldn't have to use the Release Please CLI going forward which should eliminate the need to remember the branch prefix. The risk of always falling back is that if someone configures and invalid generator version, they won't get a CI failure as feedback.

suztomo

Approving but please consider whether to use the "latest" tag.

meltsufin · 2026-04-20T21:47:29Z

Approving but please consider whether to use the "latest" tag.

@suztomo I think using the version in the target branch is more robust because it allows the code to support multiple branches with different versions of the generator.

…yaml

…g.yaml

meltsufin · 2026-04-21T02:02:24Z

@@ -1,4 +1,3 @@
-gapic_generator_version: 2.70.0


@blakeli0 Note that I'm removing this version declaration because it's confusing as it doesn't get updated, and it's not used anyway.

Agreed. We used to update this version in the daily generation PR to trigger a full generation, but we always use the latest snapshot version now after monorepo migration.

Do you intend to fix this file in the split repositories?

E.g, https://github.com/googleapis/java-firestore/blob/main/generation_config.yaml#L1

I think it's OK to wait until the other repos migrate to the monorepo.

Yep, this is resulted from monorepo migration. I don't think we want to do it for split repos.

…gle-cloud-java into release-please--fix-12825

blakeli0 · 2026-04-21T16:42:40Z

 ENV OS_ARCHITECTURE="linux-x86_64"

+# {x-version-update-start:gapic-generator-java:current}
+ENV GENERATOR_VERSION="2.71.0"


I don't think this is needed?

Yes, sdk-platform-java/hermetic_build/common/model/generation_config.py has a method __set_generator_version that checks if the gapic_generator_version is specified in the YAML file. If it is not specified in the YAML, the code falls back to reading the GENERATOR_VERSION env var.

I see. We are already setting it in the CI hermetic_library_generation.yaml though, so this is for scenarios that are not triggered through CI?

blakeli0 · 2026-04-21T16:43:41Z

@@ -1,4 +1,3 @@
-gapic_generator_version: 2.70.0


Agreed. We used to update this version in the daily generation PR to trigger a full generation, but we always use the latest snapshot version now after monorepo migration.

sonarqubecloud · 2026-04-21T17:49:42Z

Quality Gate passed for 'gapic-generator-java-root'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-04-21T17:53:53Z

Quality Gate passed for 'gapic-generator-java-root'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

meltsufin requested a review from a team as a code owner April 18, 2026 02:03

gemini-code-assist Bot reviewed Apr 18, 2026

View reviewed changes

Comment thread sdk-platform-java/.github/scripts/hermetic_library_generation.sh Outdated

meltsufin force-pushed the release-please--fix-12825 branch from 6880d59 to def6f2d Compare April 18, 2026 02:16

meltsufin added 3 commits April 17, 2026 22:19

build: extract image name to variable in hermetic script

5fa7830

build: improve robustness of fallback version extraction

823b98c

meltsufin force-pushed the release-please--fix-12825 branch from def6f2d to 823b98c Compare April 18, 2026 02:20

meltsufin mentioned this pull request Apr 18, 2026

test: Release please simulation testing #12848 #12849

Closed

build: prevent script termination on empty fallback match

c1395d2

suztomo reviewed Apr 20, 2026

View reviewed changes

Comment thread sdk-platform-java/.github/scripts/hermetic_library_generation.sh Outdated

meltsufin requested a review from suztomo April 20, 2026 15:45

blakeli0 reviewed Apr 20, 2026

View reviewed changes

suztomo approved these changes Apr 20, 2026

View reviewed changes

Comment thread sdk-platform-java/.github/scripts/hermetic_library_generation.sh Outdated

meltsufin requested a review from blakeli0 April 21, 2026 00:53

blakeli0 approved these changes Apr 21, 2026

View reviewed changes

meltsufin added 3 commits April 20, 2026 21:38

refactor: centralize generator docker execution and fallback logic

53d67a1

refactor: extract fallback tag from versions.txt instead of workflow …

16cfa1b

…yaml

refactor: remove unused gapic_generator_version from generation_confi…

ef92609

…g.yaml

meltsufin force-pushed the release-please--fix-12825 branch from 9a162ab to ef92609 Compare April 21, 2026 02:01

meltsufin commented Apr 21, 2026

View reviewed changes

meltsufin added 7 commits April 20, 2026 22:09

fix: use remote ref origin/ for fallback tag extraction in CI

54269dc

Merge branch 'main' into release-please--fix-12825

b74fe50

fix: fetch target branch to get fallback tag in CI

1ae26cc

Merge branch 'release-please--fix-12825' of github.com:googleapis/goo…

d19bfbb

…gle-cloud-java into release-please--fix-12825

impl: add GENERATOR_VERSION to final stage of Dockerfile

43835e2

chore: pass GENERATOR_VERSION to validation container in CI

68519fb

chore: pass GENERATOR_VERSION to hermetic_library_generation workflow

2cbaa3c

meltsufin added the kokoro:run Add this label to force Kokoro to re-run the tests. label Apr 21, 2026

meltsufin added kokoro:force-run Add this label to force Kokoro to re-run the tests. and removed kokoro:run Add this label to force Kokoro to re-run the tests. labels Apr 21, 2026

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Apr 21, 2026

chore: generate libraries at Tue Apr 21 11:18:32 UTC 2026

7dc57e7

meltsufin added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Apr 21, 2026

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Apr 21, 2026

blakeli0 reviewed Apr 21, 2026

View reviewed changes

suztomo approved these changes Apr 21, 2026

View reviewed changes

Merge branch 'main' into release-please--fix-12825

d07cfd9

meltsufin added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Apr 21, 2026

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Apr 21, 2026

meltsufin merged commit 3d06cba into main Apr 21, 2026
120 of 124 checks passed

meltsufin deleted the release-please--fix-12825 branch April 21, 2026 19:27

Conversation

meltsufin commented Apr 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

meltsufin commented Apr 18, 2026

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

suztomo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

meltsufin commented Apr 20, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Apr 21, 2026

Quality Gate passed for 'gapic-generator-java-root'

Uh oh!

sonarqubecloud Bot commented Apr 21, 2026

Quality Gate passed for 'gapic-generator-java-root'

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

meltsufin commented Apr 18, 2026 •

edited

Loading